GET Properties?assetId={assetId}&propertyTypeId={propertyTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves properties for the given parameters. This will only retrieve properties that have a value. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
propertyTypeId |
Id of the property type |
globally unique identifier |
None. |
take |
Number of properties to retrieve. Default is all properties |
integer |
None. |
skip |
Number of properties to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the properties before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of properties.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Property |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "PropertyId": "b770fd73-0a01-43a5-b0b9-1f1612a86b17", "Asset": { "AssetId": "1a918799-d1fd-446a-8b41-6cdbea2a154c", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "afd6dac0-7d43-4dda-8c44-4250e9b91004", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5a32b56c-d8ce-4886-b192-1a06ce8021f3", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "db6a0b96-8647-4431-940e-cec43caadd37", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-06T14:08:48.0384718-07:00", "MeasurementValueNeededDate": "2024-05-06T14:08:48.0384718-07:00", "SourceSystemId": "sample string 3", "CompanyId": "634a601b-cbfb-4e46-8b9e-a25ecfe4c398", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "a67e7a71-6cf2-4feb-926f-9649c4d885cf", "EffectiveDate": "2024-05-06T14:08:48.0384718-07:00", "StateType": { "StateTypeId": "279e6fd6-24c7-410b-addc-2670f2e5ee60", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "afd6dac0-7d43-4dda-8c44-4250e9b91004", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5a32b56c-d8ce-4886-b192-1a06ce8021f3", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "ca605e8c-f0b4-4e92-ad11-ce65bc102137", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "e1f98e4c-e4b0-4385-8fce-53e868008a49", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "56329843-2452-4763-9fe5-ae9a3f2f9c24", "EffectiveDate": "2024-05-06T14:08:48.0384718-07:00", "StatusType": { "StatusTypeId": "dbbc21bd-1630-4f21-96b8-d3486f542748", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "afd6dac0-7d43-4dda-8c44-4250e9b91004", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5a32b56c-d8ce-4886-b192-1a06ce8021f3", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "1892efec-5853-4410-93a2-077a3db6036f", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "724a7c96-f7f3-4182-bf8f-38ea76bde267", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "0e071b84-931f-407b-910d-fde9cf710630", "EffectiveDate": "2024-05-06T14:08:48.0384718-07:00", "WellPurposeType": { "WellPurposeTypeId": "e264c9e3-65b8-4502-ac5e-5f6ded8d39e7", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "e6bcb29f-2a0d-4aae-ad3c-71875e9f117a", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "2bd8174d-92a9-44b4-9140-200e457e772f", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-05-06T14:08:48.0384718-07:00", "MeasurementValueNeededDate": "2024-05-06T14:08:48.0384718-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e27dda19-d6f8-4bf8-99c5-bb8a78fb43f2", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "PropertyType": { "PropertyTypeId": "29ce9255-e3e5-48ab-a46b-52efb73c03a1", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "afd6dac0-7d43-4dda-8c44-4250e9b91004", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5a32b56c-d8ce-4886-b192-1a06ce8021f3", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 8" }, "DataType": { "DataTypeId": "ff80885e-50d1-4e0a-91bc-ad3c7a6bdf75", "Name": "sample string 1" }, "Unit": { "UnitId": "dd477db5-6184-4566-a16e-8b7d115a4e7e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c9710dc8-c1fa-4fb7-a7f8-b0189f33f4b6", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "SourceSystemId": "sample string 4", "CompanyId": "0e5e7304-90cb-45c3-994d-b4171183d2d4", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "59796567-e23a-4ae8-88fb-7ac832adf8fa", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 7" }, { "PropertyId": "b770fd73-0a01-43a5-b0b9-1f1612a86b17", "Asset": { "AssetId": "1a918799-d1fd-446a-8b41-6cdbea2a154c", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "afd6dac0-7d43-4dda-8c44-4250e9b91004", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5a32b56c-d8ce-4886-b192-1a06ce8021f3", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "db6a0b96-8647-4431-940e-cec43caadd37", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-06T14:08:48.0384718-07:00", "MeasurementValueNeededDate": "2024-05-06T14:08:48.0384718-07:00", "SourceSystemId": "sample string 3", "CompanyId": "634a601b-cbfb-4e46-8b9e-a25ecfe4c398", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "a67e7a71-6cf2-4feb-926f-9649c4d885cf", "EffectiveDate": "2024-05-06T14:08:48.0384718-07:00", "StateType": { "StateTypeId": "279e6fd6-24c7-410b-addc-2670f2e5ee60", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "afd6dac0-7d43-4dda-8c44-4250e9b91004", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5a32b56c-d8ce-4886-b192-1a06ce8021f3", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "ca605e8c-f0b4-4e92-ad11-ce65bc102137", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "e1f98e4c-e4b0-4385-8fce-53e868008a49", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "56329843-2452-4763-9fe5-ae9a3f2f9c24", "EffectiveDate": "2024-05-06T14:08:48.0384718-07:00", "StatusType": { "StatusTypeId": "dbbc21bd-1630-4f21-96b8-d3486f542748", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "afd6dac0-7d43-4dda-8c44-4250e9b91004", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5a32b56c-d8ce-4886-b192-1a06ce8021f3", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "1892efec-5853-4410-93a2-077a3db6036f", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "724a7c96-f7f3-4182-bf8f-38ea76bde267", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "0e071b84-931f-407b-910d-fde9cf710630", "EffectiveDate": "2024-05-06T14:08:48.0384718-07:00", "WellPurposeType": { "WellPurposeTypeId": "e264c9e3-65b8-4502-ac5e-5f6ded8d39e7", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "e6bcb29f-2a0d-4aae-ad3c-71875e9f117a", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "2bd8174d-92a9-44b4-9140-200e457e772f", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-05-06T14:08:48.0384718-07:00", "MeasurementValueNeededDate": "2024-05-06T14:08:48.0384718-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e27dda19-d6f8-4bf8-99c5-bb8a78fb43f2", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "PropertyType": { "PropertyTypeId": "29ce9255-e3e5-48ab-a46b-52efb73c03a1", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "afd6dac0-7d43-4dda-8c44-4250e9b91004", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5a32b56c-d8ce-4886-b192-1a06ce8021f3", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 8" }, "DataType": { "DataTypeId": "ff80885e-50d1-4e0a-91bc-ad3c7a6bdf75", "Name": "sample string 1" }, "Unit": { "UnitId": "dd477db5-6184-4566-a16e-8b7d115a4e7e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c9710dc8-c1fa-4fb7-a7f8-b0189f33f4b6", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "SourceSystemId": "sample string 4", "CompanyId": "0e5e7304-90cb-45c3-994d-b4171183d2d4", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "59796567-e23a-4ae8-88fb-7ac832adf8fa", "CreateDate": "2024-05-06T14:08:48.0384718-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T14:08:48.0384718-07:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }